Validated Enum
A validated Enum Class
Author
fzzyhmstrs
Since
0.2.0
Parameters
the enum type. Any Enum
Enum Constant used as the default for this setting
WidgetType defines the GUI selection type. Defaults to POPUP
See also
Types
Functions
updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept
, validateAndSet
, setAndUpdate
and so on will all call the listener.
Copies the stored value and returns it.
Corrects an attempted input, as possible. When correction isn't possible or deterministic, simply validate the entry the same way you would for EntryValidator
translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.
Specialized equals
method for determining if a newly deserialized value is effectively equal to its old counterpart.
Provides this validations default value
Whether this Translatable has a valid description
Whether this Translatable has a valid translation
creates a deep copy of this ValidatedEnum return ValidatedEnum wrapping a copy of the currently stored object and widget type
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept
, validateAndSet
, setAndUpdate
and so on will all call the listener.
Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue
Maps this validation to a new convertible type.
Pairs this validation with another validation into one ValidatedPair
The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.
Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.
Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.
Wraps the provided values into a ValidatedList with this field as validation
Wraps the provided collection into a ValidatedList with this field as validation
Wraps the provided values into a ValidatedSet with this field as validation
Wraps the provided collection into a ValidatedSet with this field as validation
translation key of this Translatable. the "name" in-game
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.
Validates an input per the provided validation type.
Builds a new ClickableWidget and applies a tooltip to it. This shouldn't need to be overridden in most cases